import torch  # 导入 PyTorch 库，用于构建和训练神经网络
import torch.nn as nn  # 导入 PyTorch 的神经网络模块


# 定义残差块（Residual Block）
class BasicBlock(nn.Module):
    expansion = 1  # 输出通道数扩展倍数，对于 BasicBlock 为 1

    def __init__(self, in_channels, out_channels, stride=1, downsample=None):
        super(BasicBlock, self).__init__()  # 调用父类的构造函数
        # 第一个卷积层：输入通道数为 in_channels，输出通道数为 out_channels，卷积核大小为3，步幅为 stride，填充为1，不使用偏置
        self.conv1 = nn.Conv2d(in_channels, out_channels, kernel_size=3,
                               stride=stride, padding=1, bias=False)
        self.bn1 = nn.BatchNorm2d(out_channels)  # 第一个批归一化层，输出通道数为 out_channels
        # 第二个卷积层：输入通道数为 out_channels，输出通道数为 out_channels，卷积核大小为3，步幅为1，填充为1，不使用偏置
        self.conv2 = nn.Conv2d(out_channels, out_channels, kernel_size=3,
                               stride=1, padding=1, bias=False)
        self.bn2 = nn.BatchNorm2d(out_channels)  # 第二个批归一化层，输出通道数为 out_channels
        self.downsample = downsample  # 下采样层，用于调整残差连接的尺寸
        self.relu = nn.ReLU(inplace=True)  # ReLU 激活函数，inplace=True 表示就地操作

    def forward(self, x):
        identity = x  # 保存输入 x 作为残差连接

        # 主路径的第一个卷积操作
        out = self.conv1(x)  # 应用第一个卷积层
        out = self.bn1(out)  # 应用第一个批归一化层
        out = self.relu(out)  # 应用 ReLU 激活函数

        # 主路径的第二个卷积操作
        out = self.conv2(out)  # 应用第二个卷积层
        out = self.bn2(out)  # 应用第二个批归一化层

        # 如果需要下采样，则对 identity 进行变换
        if self.downsample is not None:
            identity = self.downsample(x)  # 应用下采样层调整 identity 的尺寸

        out += identity  # 将主路径的输出与残差连接相加
        out = self.relu(out)  # 再次应用 ReLU 激活函数

        return out  # 返回最终输出


# 定义 ResNet 模型
class ResNet(nn.Module):
    def __init__(self, block, layers, num_classes=1000):
        super(ResNet, self).__init__()  # 调用父类的构造函数
        self.in_channels = 64  # 初始的输入通道数为64
        # 初始的卷积层：输入通道数为3（RGB图像），输出通道数为64，卷积核大小为7，步幅为2，填充为3，不使用偏置
        self.conv1 = nn.Conv2d(3, 64, kernel_size=7, stride=2, padding=3,
                               bias=False)
        self.bn1 = nn.BatchNorm2d(64)  # 初始的批归一化层，输出通道数为64
        self.relu = nn.ReLU(inplace=True)  # ReLU 激活函数，inplace=True 表示就地操作
        self.maxpool = nn.MaxPool2d(kernel_size=3, stride=2, padding=1)  # 最大池化层，池化核大小为3，步幅为2，填充为1

        # 残差块层，分别为 layer1 到 layer4，每一层包含不同数量的残差块
        self.layer1 = self._make_layer(block, 64, layers[0])  # 第1组残差块，输出通道数为64，包含 layers[0] 个块， 步幅为1
        self.layer2 = self._make_layer(block, 128, layers[1], stride=2)  # 第2组残差块，输出通道数为128，包含 layers[1] 个块，步幅为2
        self.layer3 = self._make_layer(block, 256, layers[2], stride=2)  # 第3组残差块，输出通道数为256，包含 layers[2] 个块，步幅为2
        self.layer4 = self._make_layer(block, 512, layers[3], stride=2)  # 第4组残差块，输出通道数为512，包含 layers[3] 个块，步幅为2
        # 全局平均池化层，将特征图的每个通道压缩为1x1的值
        self.avgpool = nn.AdaptiveAvgPool2d((1, 1))
        # 在深度神经网络中，全连接层的参数数量非常多，容易过拟合。为了避免这个问题，作者提出了使用全局平均池化层代替全连接层

        # 全连接层，输入特征数为512 * block.expansion，输出为 num_classes
        self.fc = nn.Linear(512 * block.expansion, num_classes)

        # 权重初始化
        for m in self.modules():  # 遍历模型的所有模块
            if isinstance(m, nn.Conv2d):  # 如果是卷积层
                nn.init.kaiming_normal_(m.weight, mode='fan_out', nonlinearity='relu')  # 使用 Kaiming 正态分布初始化权重
            elif isinstance(m, nn.BatchNorm2d):  # 如果是批归一化层
                nn.init.constant_(m.weight, 1)  # 将批归一化层的权重初始化为1
                nn.init.constant_(m.bias, 0)  # 将批归一化层的偏置初始化为0

    # 构建每一层的残差块
    def _make_layer(self, block, out_channels, blocks, stride=1):
        downsample = None  # 初始化下采样层为None
        # 如果输入和输出的维度不一致，需要进行下采样
        if stride != 1 or self.in_channels != out_channels * block.expansion:
            downsample = nn.Sequential(  # 定义下采样层为一个顺序容器
                nn.Conv2d(self.in_channels, out_channels * block.expansion,
                          kernel_size=1, stride=stride, bias=False),  # 1x1卷积，调整通道数和空间尺寸
                nn.BatchNorm2d(out_channels * block.expansion),  # 批归一化层
            )

        layers = []  # 初始化层列表
        # 第一个残差块可能需要下采样
        layers.append(block(self.in_channels, out_channels, stride, downsample))  # 添加第一个残差块
        self.in_channels = out_channels * block.expansion  # 更新当前输入通道数为输出通道数 * 扩展倍数
        # 其余的残差块
        for _ in range(1, blocks):
            layers.append(block(self.in_channels, out_channels))  # 添加后续残差块，无需下采样

        return nn.Sequential(*layers)  # 将层列表打包成一个顺序容器

    def forward(self, x):
        # 初始卷积层
        x = self.conv1(x)  # 应用初始卷积层
        x = self.bn1(x)  # 应用初始批归一化层
        x = self.relu(x)  # 应用 ReLU 激活函数
        x = self.maxpool(x)  # 应用最大池化层

        # 残差块层
        x = self.layer1(x)  # 应用第1组残差块
        x = self.layer2(x)  # 应用第2组残差块
        x = self.layer3(x)  # 应用第3组残差块
        x = self.layer4(x)  # 应用第4组残差块

        # 全局平均池化和全连接层
        x = self.avgpool(x)  # 应用全局平均池化层
        x = torch.flatten(x, 1)  # 将特征图展平成一维向量
        x = self.fc(x)  # 应用全连接层，得到最终输出

        return x  # 返回模型输出


# 定义 ResNet-18
def resnet18(num_classes=1000):
    return ResNet(BasicBlock, [2, 2, 2, 2], num_classes)  # 使用 BasicBlock 和 [2,2,2,2] 配置构建 ResNet-18


# 示例：创建 ResNet-18 模型并打印结构
if __name__ == "__main__":
    model = resnet18(num_classes=1000)  # 创建一个 ResNet-18 实例，类别数为1000
    print(model)  # 打印模型结构

    # 测试模型的前向传播
    input_tensor = torch.randn(1, 3, 224, 224)  # 创建一个随机输入张量，形状为[1, 3, 224, 224]
    output = model(input_tensor)  # 将输入张量通过模型进行前向传播
    print(output.shape)  # 打印输出张量的形状，应为 [1, 1000]
